
/**
 * Copyright 2009 cestum.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
package org.waveprotocol.wave.model.wave.data {
import org.goverla.collections.ArrayList;
import org.goverla.collections.HashMap;;

import org.waveprotocol.wave.model.document.operation.BufferedDocOp;
import org.waveprotocol.wave.model.id.WaveletName;
import org.waveprotocol.wave.model.wave.ParticipantId;

/**
 * Defines the abstract data type used to describe the content of a wavelet.
 *
 */
public interface WaveletData {
	// TODO: Make this code use BufferedDocInitializations.
	function getDocuments():HashMap ;
	/**
	 * An immutable list of this wave's participants, in the order in which
	 * they were added.
	 */
	function getParticipants():ArrayList ;
	function getWaveletName():WaveletName ;
	function addParticipant(participant:ParticipantId):Boolean ;
	function removeParticipant(participant:ParticipantId):Boolean ;
	function modifyDocument(documentId:String, op:BufferedDocOp):Boolean ;
}
}